<!-- This comment will put IE 6, 7 and 8 in quirks mode -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>include/shark/Algorithms/QP/QuadraticProgram.h Source File</title>
<script type="text/javaScript" src="search/search.js"></script>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<script src="https://polyfill.io/v3/polyfill.min.js?features=es6"></script>
<script id="MathJax-script" async src="https://cdn.jsdelivr.net/npm/mathjax@3.0.1/es5/tex-mml-chtml.js"></script>
<script src="../../mlstyle.js"></script>
<link href="../css/besser.css" rel="stylesheet" type="text/css"/>
</head>
<!-- pretty cool: each body gets an id tag which is the basename of the web page  -->
<!--              and allows for page-specific CSS. this is client-side scripted, -->
<!--              so the id will not yet show up in the served source code -->
<script type="text/javascript">
    jQuery(document).ready(function () {
        var url = jQuery(location).attr('href');
        var pname = url.substr(url.lastIndexOf("/")+1, url.lastIndexOf(".")-url.lastIndexOf("/")-1);
        jQuery('#this_url').html('<strong>' + pname + '</strong>');
        jQuery('body').attr('id', pname);
    });
</script>
<body>
    <div id="shark_old">
        <div id="wrap">
            <div id="header">
                <div id="site-name"><a href="../../sphinx_pages/build/html/index.html">Shark machine learning library</a></div>
                <ul id="nav">
                    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/installation.html">Installation</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/tutorials/tutorials.html">Tutorials</a>
                    </li>
		    <li >
                        <a href="../../sphinx_pages/build/html/rest_sources/benchmark.html">Benchmarks</a>
                    </li>
                    <li class="active">
                        <a href="classes.html">Documentation</a>
                        <ul>
                            <li class="first"></li>
                            <li><a href="../../sphinx_pages/build/html/rest_sources/quickref/quickref.html">Quick references</a></li>
                            <li><a href="classes.html">Class list</a></li>
                            <li class="last"><a href="group__shark__globals.html">Global functions</a></li>
                        </ul>
                    </li>
                </ul>
            </div>
        </div>
    </div>
<div id="doxywrapper">
<!--
    <div id="global_doxytitle">Doxygen<br>Documentation:</div>
-->
    <div id="navrow_wrapper">
<!-- Generated by Doxygen 1.9.8 -->
<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_9d0c4981f10d03078bcfd5c74fe41ce8.html">shark</a></li><li class="navelem"><a class="el" href="dir_24fc231769ada4cfc8add7cd238ad0f8.html">Algorithms</a></li><li class="navelem"><a class="el" href="dir_92335953225e003073501ac6d6eaa70f.html">QP</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">QuadraticProgram.h</div></div>
</div><!--header-->
<div class="contents">
<a href="_quadratic_program_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">//===========================================================================</span><span class="comment"></span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment">/*!</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> * </span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> *</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * \brief       Quadratic programming for Support Vector Machines</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * </span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * </span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> * \par</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> * This file provides a number of classes representing hugh dense</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> * matrices all related to kernel Gram matices of possibly large</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * datasets. These classes share a common interface for</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * (a) providing a matrix entry,</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * (b) swapping two variable indices, and</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * (c) returning the matrix size.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * </span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * \par</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"> * This interface is required by the template class CachedMatrix,</span></div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment"> * which provides a cache mechanism for restricted matrix rows, as it</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"> * is used by various quadratic program solvers within the library.</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span><span class="comment"> * The PrecomputedMatrix provides a sometimes faster but more memory</span></div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="comment"> * intensive alternative to CachedMatrix.</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="comment"> * </span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="comment"> * </span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="comment"> * </span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="comment"> *</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="comment"> * \author      T. Glasmachers</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="comment"> * \date        2007-2012</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="comment"> *</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="comment"> *</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span><span class="comment"> * \par Copyright 1995-2017 Shark Development Team</span></div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="comment"> * </span></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span><span class="comment"> * &lt;BR&gt;&lt;HR&gt;</span></div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span><span class="comment"> * This file is part of Shark.</span></div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment"> * &lt;https://shark-ml.github.io/Shark/&gt;</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"> * </span></div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment"> * Shark is free software: you can redistribute it and/or modify</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * it under the terms of the GNU Lesser General Public License as published </span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * by the Free Software Foundation, either version 3 of the License, or</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> * (at your option) any later version.</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * </span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * Shark is distributed in the hope that it will be useful,</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * GNU Lesser General Public License for more details.</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * </span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> * You should have received a copy of the GNU Lesser General Public License</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * along with Shark.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> *</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> */</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment">//===========================================================================</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="preprocessor">#ifndef SHARK_ALGORITHMS_QP_QUADRATICPROGRAM_H</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="preprocessor">#define SHARK_ALGORITHMS_QP_QUADRATICPROGRAM_H</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span> </div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="preprocessor">#include &lt;cmath&gt;</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span> </div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceshark.html" title="AbstractMultiObjectiveOptimizer.">shark</a> {</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"></span> </div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment">/// reason for the quadratic programming solver</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment">/// to stop the iterative optimization process</span></div>
<div class="foldopen" id="foldopen00063" data-start="{" data-end="};">
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"><a class="line" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540">   63</a></span><span class="comment"></span><span class="keyword">enum</span> <a class="code hl_enumeration" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540">QpStopType</a></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span>{</div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno"><a class="line" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540ab544fb3e76bdbaf78448f2416367ccc7">   65</a></span>    <a class="code hl_enumvalue" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540ab544fb3e76bdbaf78448f2416367ccc7">QpNone</a> = 0,</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540a4b605bae89750d1c2bb1b3ef1a039639">   66</a></span>    <a class="code hl_enumvalue" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540a4b605bae89750d1c2bb1b3ef1a039639">QpAccuracyReached</a> = 1,</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540a1f2d9c58ed6b0985decbfe573d66080d">   67</a></span>    <a class="code hl_enumvalue" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540a1f2d9c58ed6b0985decbfe573d66080d">QpMaxIterationsReached</a> = 4,</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540af0f960c500ba6a3c653c9f45efa6e92a">   68</a></span>    <a class="code hl_enumvalue" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540af0f960c500ba6a3c653c9f45efa6e92a">QpTimeout</a> = 8,</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>};</div>
</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span> </div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span><span class="comment"></span> </div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment">///</span></div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">/// \brief stopping conditions for quadratic programming</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno">   74</span><span class="comment">///</span></div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">/// The QpStoppingCondition structure defines conditions</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno">   77</span><span class="comment">/// for stopping the optimization procedure.</span></div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span><span class="comment">///</span></div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span><span class="comment">//! \par</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span><span class="comment">//! For practical considerations the solvers supports</span></div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span><span class="comment">//! several stopping conditions. Usually, the optimization</span></div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span><span class="comment">//! stops if the Karush-Kuhn-Tucker (KKT) condition for</span></div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span><span class="comment">//! optimality are satisfied up to a certain accuracy.</span></div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span><span class="comment">//! In the case the optimal function value is known a</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span><span class="comment">//! priori it is possible to stop as soon as the objective</span></div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span><span class="comment">//! is above a given threshold. In both cases it is very</span></div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span><span class="comment">//! difficult to predict the runtime. Therefore the</span></div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span><span class="comment">//! solver can stop after a predefined number of</span></div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span><span class="comment">//! iterations or after a predefined time period. In</span></div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span><span class="comment">//! these cases the solution found will not be near</span></div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span><span class="comment">//! optimal. In SVM training, using sensitive settings,</span></div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span><span class="comment">//! this should happen only during model selection while</span></div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span><span class="comment">//! investigating hyperparameters with poor</span></div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span><span class="comment">//! generalization ability.</span></div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span><span class="comment">//!</span></div>
<div class="foldopen" id="foldopen00096" data-start="{" data-end="};">
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_stopping_condition.html">   96</a></span><span class="comment"></span><span class="keyword">struct </span><a class="code hl_struct" href="structshark_1_1_qp_stopping_condition.html" title="stopping conditions for quadratic programming">QpStoppingCondition</a></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>{<span class="comment"></span></div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment">    /// Constructor</span></div>
<div class="foldopen" id="foldopen00099" data-start="{" data-end="}">
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_stopping_condition.html#a71120944a5b9a474f278fb346d82019c">   99</a></span><span class="comment"></span>    <a class="code hl_function" href="structshark_1_1_qp_stopping_condition.html#a71120944a5b9a474f278fb346d82019c" title="Constructor.">QpStoppingCondition</a>(<span class="keywordtype">double</span> accuracy = 0.001, <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> iterations = 0xffffffff, <span class="keywordtype">double</span> value = 1e100, <span class="keywordtype">double</span> seconds = 1e100)</div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span>    {</div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span>        <a class="code hl_variable" href="structshark_1_1_qp_stopping_condition.html#addc2ea7f6d15eb25187586e329f33ace" title="minimum accuracy to be achieved, usually KKT violation">minAccuracy</a> = accuracy;</div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span>        <a class="code hl_variable" href="structshark_1_1_qp_stopping_condition.html#af747ff263a208a610fc2ca4dccec44d6" title="maximum number of decomposition iterations (default to 0 - not used)">maxIterations</a> = iterations;</div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno">  103</span>        <a class="code hl_variable" href="structshark_1_1_qp_stopping_condition.html#aef0871941c7b0acd271996801b05b47b" title="target objective function value (defaults to 1e100 - not used)">targetValue</a> = value;</div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>        <a class="code hl_variable" href="structshark_1_1_qp_stopping_condition.html#a2f2037cc62c817ff88ec0801591a0240" title="maximum process time (defaults to 1e100 - not used)">maxSeconds</a> = seconds;</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>    }</div>
</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span><span class="comment"></span> </div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span><span class="comment">    /// minimum accuracy to be achieved, usually KKT violation</span></div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_stopping_condition.html#addc2ea7f6d15eb25187586e329f33ace">  108</a></span><span class="comment"></span>    <span class="keywordtype">double</span> <a class="code hl_variable" href="structshark_1_1_qp_stopping_condition.html#addc2ea7f6d15eb25187586e329f33ace" title="minimum accuracy to be achieved, usually KKT violation">minAccuracy</a>;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"></span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">    /// maximum number of decomposition iterations (default to 0 - not used)</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_stopping_condition.html#af747ff263a208a610fc2ca4dccec44d6">  111</a></span><span class="comment"></span>    <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code hl_variable" href="structshark_1_1_qp_stopping_condition.html#af747ff263a208a610fc2ca4dccec44d6" title="maximum number of decomposition iterations (default to 0 - not used)">maxIterations</a>;</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span><span class="comment"></span> </div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span><span class="comment">    /// target objective function value (defaults to 1e100 - not used)</span></div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_stopping_condition.html#aef0871941c7b0acd271996801b05b47b">  114</a></span><span class="comment"></span>    <span class="keywordtype">double</span> <a class="code hl_variable" href="structshark_1_1_qp_stopping_condition.html#aef0871941c7b0acd271996801b05b47b" title="target objective function value (defaults to 1e100 - not used)">targetValue</a>;</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span><span class="comment"></span> </div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span><span class="comment">    /// maximum process time (defaults to 1e100 - not used)</span></div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_stopping_condition.html#a2f2037cc62c817ff88ec0801591a0240">  117</a></span><span class="comment"></span>    <span class="keywordtype">double</span> <a class="code hl_variable" href="structshark_1_1_qp_stopping_condition.html#a2f2037cc62c817ff88ec0801591a0240" title="maximum process time (defaults to 1e100 - not used)">maxSeconds</a>;</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span>};</div>
</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span> </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"></span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">///</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno">  122</span><span class="comment">/// \brief properties of the solution of a quadratic program</span></div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment">///</span></div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">/// \par</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno">  125</span><span class="comment">/// The QpSolutionProperties structure collects statistics</span></div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment">/// about the approximate solutions found in a solver run.</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">/// It reports the reason for the iterative solver to stop,</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno">  128</span><span class="comment">/// which was set according to the QpStoppingCondition</span></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span><span class="comment">/// structure. Furthermore it reports the solution accuracy,</span></div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment">/// the number of iterations, time elapsed, and the value</span></div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">/// of the objective function in the reported solution.</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno">  132</span><span class="comment">///</span></div>
<div class="foldopen" id="foldopen00133" data-start="{" data-end="};">
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_solution_properties.html">  133</a></span><span class="comment"></span><span class="keyword">struct </span><a class="code hl_struct" href="structshark_1_1_qp_solution_properties.html" title="properties of the solution of a quadratic program">QpSolutionProperties</a></div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span>{</div>
<div class="foldopen" id="foldopen00135" data-start="{" data-end="}">
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_solution_properties.html#a43adbf4089a94cf2124fc28602600719">  135</a></span>    <a class="code hl_function" href="structshark_1_1_qp_solution_properties.html#a43adbf4089a94cf2124fc28602600719">QpSolutionProperties</a>()</div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno">  136</span>    {</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span>        type = <a class="code hl_enumvalue" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540ab544fb3e76bdbaf78448f2416367ccc7">QpNone</a>;</div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span>        <a class="code hl_variable" href="structshark_1_1_qp_solution_properties.html#a754cf16ef14ec337a626ab31c11ac444" title="typically the maximal KKT violation">accuracy</a> = 1e100;</div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno">  139</span>        <a class="code hl_variable" href="structshark_1_1_qp_solution_properties.html#aa1b7fb15931dfebb70364b0bf949fa15" title="number of decomposition iterations">iterations</a> = 0;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span>        <a class="code hl_variable" href="structshark_1_1_qp_solution_properties.html#aa3b4e5dcba8e39ee858c6ea36c8879b3" title="value of the objective function">value</a> = 1e100;</div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span>        <a class="code hl_variable" href="structshark_1_1_qp_solution_properties.html#a965ff3df7a7c9ae101b0b06e82921c91" title="training time">seconds</a> = 0.0;</div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno">  142</span>    }</div>
</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>    <a class="code hl_enumeration" href="namespaceshark.html#a2d5e9a415ae7e8dd41caf883e1873540">QpStopType</a> type;                        <span class="comment">///&lt; reason for the solver to stop</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_solution_properties.html#a754cf16ef14ec337a626ab31c11ac444">  145</a></span>    <span class="keywordtype">double</span> <a class="code hl_variable" href="structshark_1_1_qp_solution_properties.html#a754cf16ef14ec337a626ab31c11ac444" title="typically the maximal KKT violation">accuracy</a>;                        <span class="comment">///&lt; typically the maximal KKT violation</span></div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_solution_properties.html#aa1b7fb15931dfebb70364b0bf949fa15">  146</a></span>    <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code hl_variable" href="structshark_1_1_qp_solution_properties.html#aa1b7fb15931dfebb70364b0bf949fa15" title="number of decomposition iterations">iterations</a>;          <span class="comment">///&lt; number of decomposition iterations</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_solution_properties.html#aa3b4e5dcba8e39ee858c6ea36c8879b3">  147</a></span>    <span class="keywordtype">double</span> <a class="code hl_variable" href="structshark_1_1_qp_solution_properties.html#aa3b4e5dcba8e39ee858c6ea36c8879b3" title="value of the objective function">value</a>;                           <span class="comment">///&lt; value of the objective function</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno"><a class="line" href="structshark_1_1_qp_solution_properties.html#a965ff3df7a7c9ae101b0b06e82921c91">  148</a></span>    <span class="keywordtype">double</span> <a class="code hl_variable" href="structshark_1_1_qp_solution_properties.html#a965ff3df7a7c9ae101b0b06e82921c91" title="training time">seconds</a>;                         <span class="comment">///&lt; training time</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span>};</div>
</div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span> </div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span>}</div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
</div>
</body>
</html>
